Skip to content

[doc] Add user manual for Decimo library and the CLI tool#184

Merged
forfudan merged 2 commits intoclifrom
update
Mar 6, 2026
Merged

[doc] Add user manual for Decimo library and the CLI tool#184
forfudan merged 2 commits intoclifrom
update

Conversation

@forfudan
Copy link
Copy Markdown
Owner

@forfudan forfudan commented Mar 6, 2026

This PR adds end-user documentation for Decimo’s library APIs and the decimo CLI calculator, plus minor documentation/planning updates and a numeric-syntax comment in the string parser.

Changes:

  • Add a comprehensive Decimo library user manual (BigInt/BigDecimal) with examples and API tables.
  • Add a CLI calculator user manual documenting syntax, flags, examples, and --help output.
  • Update CLI calculator plan/roadmap docs; add an EBNF numeric-syntax comment in parse_numeric_string.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds end-user documentation for Decimo’s library APIs and the decimo CLI calculator, plus minor documentation/planning updates and a numeric-syntax comment in the string parser.

Changes:

  • Add a comprehensive Decimo library user manual (BigInt/BigDecimal) with examples and API tables.
  • Add a CLI calculator user manual documenting syntax, flags, examples, and --help output.
  • Update CLI calculator plan/roadmap docs; add an EBNF numeric-syntax comment in parse_numeric_string.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
src/decimo/str.mojo Adds an EBNF-style comment describing numeric-string syntax near parse_numeric_string().
docs/user_manual_cli.md New CLI user manual covering expression syntax, options, examples, and error messages.
docs/user_manual.md New library user manual for Decimo types/APIs (BigInt/BigDecimal) with extensive examples.
docs/plans/cli_calculator.md Updates planning doc with status tables for implemented CLI phases/tasks.
docs/plans/api_roadmap.md Removes completed/outdated roadmap items (e.g., sign()/format-control sections).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Comment thread src/decimo/str.mojo
Comment thread src/decimo/str.mojo Outdated
Comment thread docs/user_manual_cli.md Outdated
Comment thread docs/user_manual_cli.md Outdated
Comment thread docs/user_manual_cli.md Outdated
Comment thread src/decimo/str.mojo Outdated
@forfudan forfudan merged commit 99fac30 into cli Mar 6, 2026
9 checks passed
@forfudan forfudan deleted the update branch March 6, 2026 20:26
forfudan added a commit that referenced this pull request Mar 23, 2026
This PR adds end-user documentation for Decimo’s library APIs and the
`decimo` CLI calculator, plus minor documentation/planning updates and a
numeric-syntax comment in the string parser.

**Changes:**
- Add a comprehensive Decimo library user manual (`BigInt`/`BigDecimal`)
with examples and API tables.
- Add a CLI calculator user manual documenting syntax, flags, examples,
and `--help` output.
- Update CLI calculator plan/roadmap docs; add an EBNF numeric-syntax
comment in `parse_numeric_string`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants